// ============================================================================
//
// Copyright (C) 2006-2007 Dengues
//
// Google Group: http://groups.google.com/group/dengues
// QQ Group: 24885404
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
//
// ============================================================================
package org.dengues.ui.web.browser.event;

import org.eclipse.swt.browser.Browser;
import org.eclipse.swt.browser.ProgressEvent;
import org.eclipse.swt.browser.ProgressListener;
import org.eclipse.swt.internal.SWTEventListener;

/**
 * This listener interface may be implemented in order to receive a {@link ProgressEvent} notification when a
 * {@link Browser} makes a progress in loading the current URL or when the current URL has been loaded.
 * 
 * @see Browser#addProgressListener(ProgressListener)
 * @see Browser#removeProgressListener(ProgressListener)
 * @see Browser#getUrl()
 * @author jliu
 */
public interface DenguesProgressListener extends SWTEventListener {

    /**
     * This method is called when a progress is made during the loading of the current location.
     * <p>
     * <p>
     * The following fields in the <code>ProgressEvent</code> apply:
     * <ul>
     * <li>(in) current the progress for the location currently being loaded
     * <li>(in) total the maximum progress for the location currently being loaded
     * <li>(in) widget the <code>Browser</code> whose current URL is being loaded
     * </ul>
     * 
     * @param event the <code>ProgressEvent</code> related to the loading of the current location of a
     * <code>Browser</code>
     * @since 3.0
     */
    public void changed(DenguesProgressEvent event);

    /**
     * This method is called when the current location has been completely loaded.
     * <p>
     * <p>
     * The following fields in the <code>ProgressEvent</code> apply:
     * <ul>
     * <li>(in) widget the <code>Browser</code> whose current URL has been loaded
     * </ul>
     * 
     * @param event the <code>ProgressEvent</code> related to the <code>Browser</code> that has loaded its current
     * URL.
     * @since 3.0
     */
    public void completed(DenguesProgressEvent event);
}
